Skip to content

Commit

Permalink
📝 [docs + S/C/Roland] Update docs, Roland
Browse files Browse the repository at this point in the history
  • Loading branch information
alicerunsonfedora committed Feb 20, 2021
1 parent f23a526 commit 4436bc7
Show file tree
Hide file tree
Showing 10 changed files with 61 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/07-roland-boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ There are two additional parameters that can be passed into the boot function:

The Roland Boot Manager comes with a few loading screens by default:

- `RolandGraphicalLoader`: A graphical loader with the game's window icon, if the file is present. Otherwise, the Candella logo is displayed.
- `RolandGraphicalLogomarkLoader`: A graphical loader that displays the Candella logomark.
- `RolandTextLoader`: A text-based loader that displays the contents of the Candella log file.
| Preview | Loader name | Description |
| ------- | ----------- | ----------- |
| ![](/images/roland/graphic.png) | `RolandGraphicalLoader` | A graphical loader with the game's window icon, if the file is present. Otherwise, the Candella logo is displayed. |
| ![](/images/roland/graphic-logomark.png) | `RolandGraphicalLogomarkLoader` | A graphical loader that displays the Candella logomark, as well as a row of icons at the bottom for all of the core services installed. |
| ![](/images/roland/text.png) | `RolandTextLoader` | A text-based loader that displays the contents of the Candella log file. |

### Creating a custom loading screen

Expand Down
32 changes: 32 additions & 0 deletions docs/96-design-and-branding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Design and branding

Candella includes utilities and modules that help ensure the system's design language is followed, as well as provide branding images.

## Design

Candella, in large part, follows the Suru design guidelines and is commonly seen in the icons and font (Ubuntu). The `CADesign` module contains some utilities to help facilitate following the design language.

### `get_app_mask_frame()`

Returns a Frame object with a mask of the app's general shape.

### `get_app_mask(icon, size)`

Returns an AlphaMask displayable with the app's general shape masked on to the specified `icon` with a size of `size x size` pixels.

## Branding

The `Branding` directory inside of the `System/Library` directory contains logomarks and sprites that can be used throughout Candella. Please, do not use these images to represent your app or service.

![Logomark](/images/branding/logomark.png)
<small>

*The logomark is best used on a dark background.

</small>

| | |
| - | - |
| ![Logo sprite](/images/branding/sprite.png) | ![Alternate logo sprite](/images/branding/sprite_alt.png) |

Note that, for fonts, the Ubuntu font is used.
23 changes: 23 additions & 0 deletions docs/97-deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Deprecations

Candella includes a small module that facilitates deprecating functions. To mark a function as deprecated, import the function and decorate the function you want to deprecate:

```py
from store.CADeprecated import deprecated

@deprecated('21.02')
def deprecated_func():
pass

```

When the function is called, a warning message will appear in the console and the Candella log file indicating that the function was deprecated, as well as the reason for the deprecation, if one was specified.

!!! important
The `deprecated` function has been tested on functions and class methods, but hasn't been tested or designed for variables, class fields, or classes themselves. Use with caution.

## `deprecated` arguments

- `version` (str): The version in which the function will be deprecated.
- `renamed` (str): (Optional) What the function has been renamed to, if the function was renamed.
- `reason` (str): (Optional) The reason why the function was deprecated.
Binary file added docs/images/branding/logomark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/branding/sprite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/branding/sprite_alt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/roland/graphic-logomark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/roland/graphic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/roland/text.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ style RolandText_frame is frame:
padding (4, 4)

style RolandText_text is text:
font get_font("Unicode")
font get_font("Unicode", variant="Fixed")
line_spacing 0
antialias False
size 16

0 comments on commit 4436bc7

Please sign in to comment.