The mass conversion of the User Guide content to Help Center docs is complete. Assets have been updated, project
has been restructured, and some documentation has been intentionally deleted (advanced bits) and extremely outdated Installation documentation. Time to get to work on the wiki content.
This commit is contained in:
Joshua Strobl
parent
0513be7328
commit
a52f7f67f9
|
|
@ -1,64 +0,0 @@
|
|||
# Custom Syntax
|
||||
|
||||
This document highlights custom Markdown syntax that is implemented (or is planned to be implemented) throughout the User Guide Markdown as well as the parser.
|
||||
|
||||
All of these custom syntax will result in DOM elements with specific styling / attributes via our parser.
|
||||
|
||||
## Blocks
|
||||
|
||||
### Basics
|
||||
|
||||
Each "block" is either a start or end block.
|
||||
|
||||
- Custom syntax that is the start of a block begins with `syntax.start`
|
||||
- Custom syntax that is the end of a block **is** `syntax.end`
|
||||
|
||||
Each block syntax begins with `{{ ` and ends with `}}`.
|
||||
|
||||
**Example:**
|
||||
|
||||
``` markdown
|
||||
{{ syntax.start:float-left }}
|
||||
Content
|
||||
{{ syntax.end }}
|
||||
```
|
||||
|
||||
### Parsing
|
||||
|
||||
When parsing the syntax as DOM elements:
|
||||
1. `syntax.start` blocks are parsed as `<div data-userguide-styling="n">` where `n` is the proceeding syntax after `syntax.start`
|
||||
2. `syntax.end` blocks are parsed as `</div>`
|
||||
|
||||
**Example:**
|
||||
|
||||
``` html
|
||||
<div data-userguide-styling="float-left">
|
||||
Content
|
||||
</div>
|
||||
```
|
||||
|
||||
## Syntax
|
||||
|
||||
Each syntax below exempts the start / end block.
|
||||
|
||||
### Alignment
|
||||
|
||||
Description | Syntax
|
||||
----- | -----
|
||||
Floats content to left, allows text wrapping | `float-left`
|
||||
Floats content to right, allows text wrapping | `float-right`
|
||||
Centers content, no text wrapping | `center`
|
||||
|
||||
Float left syntax is usually not necessary but may be useful when the inner content is an image.
|
||||
|
||||
### Note
|
||||
|
||||
Sometimes having blocks of textual content that are intended to be subtle notes before or after more important content is needed. These notes are done via the `note` syntax.
|
||||
|
||||
**Example:**
|
||||
|
||||
``` markdown
|
||||
{{ syntax.start:note }}
|
||||
This is a note.
|
||||
{{ syntax.end }}
|
||||
```
|
||||
|
|
@ -1,27 +1,30 @@
|
|||
# User Guide #
|
||||
# Help Center Documentation
|
||||
|
||||
This is the repository of the Solus Project's User Guide. Stumbled on this repo and have no idea what any of this is? Check out the [Solus Project](https://solus-project.com) and our Solus Operating System.
|
||||
This is the repository for Solus's future Help Center documentation as well as previous User Guide. This repository exists to help facilitate and encourage community contributions to improving our
|
||||
documentation and enabling an easier user experience for everyone.
|
||||
|
||||
## TODO ##
|
||||
Stumbled on this repo and have no idea what any of this is? Check out the [Solus](https://solus-project.com) operating system!
|
||||
|
||||
TODO:
|
||||
## TODO
|
||||
|
||||
- [x] Convert User Guide to Markdown files.
|
||||
- [ ] Create build system that aggregates Markdown files, swaps out our custom syntax for HTML, then use the HTML to generate PDFs.
|
||||
- [ ] Actually document and create consistent custom Markdown syntaxes.
|
||||
- [ ] Deliver Release 2 of User Guide
|
||||
*In order.*
|
||||
|
||||
## Licenses ##
|
||||
- [ ] The current task is to migrate all documentation from the [Solus Wiki](https://wiki.solus-project.com).
|
||||
- [ ] Leveraging this repo in the creation of our Help Center.
|
||||
- [ ] Create a basic build system that aggregates specific Markdown files and assets to produce a User Guide. This will enable our User Guides to be generated whenever necessary, such as during the release
|
||||
of a new ISO snapshot.
|
||||
|
||||
**Build System**
|
||||
## Licenses
|
||||
|
||||
### Build System
|
||||
|
||||
Files relating to the parsing / build system are licensed under GPL-2.0. For the full text, view LICENSE.txt.
|
||||
|
||||
**Markdown**
|
||||
### Markdown
|
||||
|
||||
The Markdown files in this repository are licensed under the Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.
|
||||
|
||||
**Media Assets**
|
||||
### Media Assets
|
||||
|
||||
- Solus Project logo is owned wholly by Solus Project.
|
||||
- Solus logo copyright and licensing information is provided on our [Brand Guidelines page](https://solus-project.com/brand-guidelines).
|
||||
- Non-logo assets are licensed under Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# Budgie Shortcuts
|
||||
|
||||
Budgie provides multiple shortcuts to make navigating around Budgie faster and easier.
|
||||
|
||||
Keyboard Shortcut | Action
|
||||
----- | -----
|
||||
Windows Key (*also Windows key + S*) | Open Budgie Menu
|
||||
Windows Key + A | Open Applets section of Raven
|
||||
Windows Key + N | Open Notifications section of Raven
|
||||
4
content/en/common-tasks/browsing-the-web.md → content/common-tasks/browsing-the-web/en.md
Normal file → Executable file
4
content/en/common-tasks/browsing-the-web.md → content/common-tasks/browsing-the-web/en.md
Normal file → Executable file
|
|
@ -1,5 +1,5 @@
|
|||
## Browsing the web
|
||||
|
||||
|
||||
|
||||
Solus comes pre-installed with Firefox, a secure and trustworthy web browser provided by the non-profit organization [Mozilla](https://www.mozilla.org/en-US/).
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 286 KiB |
4
content/en/common-tasks/checking-email.md → content/common-tasks/checking-email/en.md
Normal file → Executable file
4
content/en/common-tasks/checking-email.md → content/common-tasks/checking-email/en.md
Normal file → Executable file
|
|
@ -1,5 +1,5 @@
|
|||
## Checking Email
|
||||
|
||||
|
||||
|
||||
Solus comes pre-installed with the powerful [Thunderbird](https://www.mozilla.org/en-US/thunderbird/) email, newsgroup, and feeds client.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
|
|
@ -0,0 +1,5 @@
|
|||
## Installing and updating software
|
||||
|
||||
You can install software ranging from Google Chrome to LibreOffice, as well as updating software, via our Software Center.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
4
content/en/common-tasks/listening-to-music.md → content/common-tasks/listening-to-music/en.md
Normal file → Executable file
4
content/en/common-tasks/listening-to-music.md → content/common-tasks/listening-to-music/en.md
Normal file → Executable file
|
|
@ -1,5 +1,5 @@
|
|||
## Listening to music
|
||||
|
||||
|
||||
|
||||
Solus comes pre-installed with the rockin’ music player Rhythmbox as well as the necessary codecs to play all your favorite music!
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
2
content/en/common-tasks/managing-your-files.md → content/common-tasks/managing-your-files/en.md
Normal file → Executable file
2
content/en/common-tasks/managing-your-files.md → content/common-tasks/managing-your-files/en.md
Normal file → Executable file
|
|
@ -1,5 +1,5 @@
|
|||
## Managing your files
|
||||
|
||||
|
||||
|
||||
|
||||
Solus provides software that enables you to store, organize, and view your files (such as documents, music, pictures, and videos).
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
4
content/en/common-tasks/watching-videos.md → content/common-tasks/watching-videos/en.md
Normal file → Executable file
4
content/en/common-tasks/watching-videos.md → content/common-tasks/watching-videos/en.md
Normal file → Executable file
|
|
@ -1,5 +1,5 @@
|
|||
## Watching Videos
|
||||
|
||||
|
||||
|
||||
Solus comes pre-installed with the [VLC Media Player](http://www.videolan.org/vlc/index.html), enabling you to watch your favorite movies, t.v. shows, DVDs, and Blu-rays.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
|
|
@ -0,0 +1,11 @@
|
|||
# Changing Background
|
||||
|
||||
You can change your background by going to the Budgie Menu, opening Settings, then clicking Background.
|
||||
|
||||
|
||||
|
||||
You will have two options, Background and Lock Screen. Select Background.
|
||||
|
||||
In this section, you can choose between predefined wallpapers, pictures in your Pictures folder, or solid colors. After choosing, click Select.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 529 KiB |
4
content/en/managing-your-system/configuring-date-and-time.md → content/configuration/configuring-date-and-time/en.md
Normal file → Executable file
4
content/en/managing-your-system/configuring-date-and-time.md → content/configuration/configuring-date-and-time/en.md
Normal file → Executable file
|
|
@ -1,6 +1,6 @@
|
|||
## Configuring Date and time
|
||||
# Configuring Date and time
|
||||
|
||||
|
||||
|
||||
|
||||
You can configure the date and time of your system by going to the Budgie Menu, opening the Settings app then going to the Date & Time section.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
|
|
@ -1,10 +1,11 @@
|
|||
## Configuring Default Applications
|
||||
# Configuring Default Applications
|
||||
|
||||
You can configure default applications by going to the Budgie Menu, opening Settings app, and going to the Details section.
|
||||
|
||||
Upon entering the Details section, go to Default Applications.
|
||||
|
||||
|
||||
|
||||
|
||||
*Note: In the image above, we've changed the Music player and Video player.*
|
||||
|
||||
You can change default applications for:
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
8
content/en/managing-your-system/configuring-displays.md → content/configuration/configuring-displays/en.md
Normal file → Executable file
8
content/en/managing-your-system/configuring-displays.md → content/configuration/configuring-displays/en.md
Normal file → Executable file
|
|
@ -1,14 +1,14 @@
|
|||
## Configuring Displays
|
||||
# Configuring Displays
|
||||
|
||||
You can configure your display(s) by going to the Budgie Menu, opening the Settings app, and clicking the Displays section.
|
||||
|
||||
You will then be shown the following window.
|
||||
|
||||
|
||||
|
||||
|
||||
In this window, you can select individual displays to configure. Clicking on an item will show the following dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
This window will enable you to select if you wish to use this monitor as the primary or secondary display, mirror it with another display, or turn it off.
|
||||
|
||||
|
|
@ -16,4 +16,4 @@ It also gives you size and aspect ratio, ability to rotate the display, and abil
|
|||
|
||||
Going back to the Displays section, you also have the option to arrange your displays. Click the “Arrange Combined Displays” to be presented with the following window.
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
|
|
@ -0,0 +1,21 @@
|
|||
# Configuring Keyboard Layout
|
||||
|
||||
You can change your language by going to the Budgie Menu, opening Settings, then clicking Region and Language.
|
||||
|
||||
You will now be shown the following dialog.
|
||||
|
||||
|
||||
|
||||
Click the `+` button to add an input source (keyboard layout). You will be shown the following dialog.
|
||||
|
||||
|
||||
|
||||
Here you can select the language and then keyboard layout within each language section. If it does not appear in this list, click the ⋮ button. This will enable you to search for the keyboard layout you wish to use.
|
||||
|
||||
After choosing the keyboard layout, click Done. You will be brought back to the following dialog with your new keyboard layout. In the image below, we are now using English (US), Finnish, and Swedish layout.
|
||||
|
||||
|
||||
|
||||
You can remove a keyboard layout by click on one of the items, for instance Swedish, then clicking the `-` button.
|
||||
|
||||
If you wish to use multiple keyboard layouts, you can switch to them by using: `Windows key + Space` or by adding the Keyboard Layout Indicator applet to your Budgie panel.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
6
content/en/managing-your-system/configuring-language.md → content/configuration/configuring-language/en.md
Normal file → Executable file
6
content/en/managing-your-system/configuring-language.md → content/configuration/configuring-language/en.md
Normal file → Executable file
|
|
@ -4,16 +4,16 @@ You can change your language by going to the Budgie Menu, opening Settings, then
|
|||
|
||||
You will now be shown the following dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
In this dialog, click Language. The following dialog will appear.
|
||||
|
||||
|
||||
|
||||
|
||||
Here, you can select the language you wish your system to use. If it does not appear in this list, click the ⋮ button.
|
||||
|
||||
You will come across the following dialog where you can type your language.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the language from the list and click Done. You **may** need to logout and login to your computer for it to take affect.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
|
|
@ -0,0 +1,29 @@
|
|||
## Configuring Mouse and Touchpad
|
||||
|
||||
You can configure the settings of your mouse and/or touchpad by going to the Budgie Menu, opening the Settings app, then clicking the Mouse & Touchpad section. You will be either one of the following windows, depending on the device.
|
||||
|
||||
### Mouse
|
||||
|
||||
|
||||
|
||||
For mice, you can set:
|
||||
|
||||
- The primary button (usually left click) to be left or right
|
||||
- Mouse speed
|
||||
- Enabling / disabling "natural scrolling" (reversed scrolling direction)
|
||||
|
||||
### Touchpad
|
||||
|
||||
|
||||
|
||||
For touchpads, you can set:
|
||||
|
||||
- The primary button (usually left click) to be left or right
|
||||
- Enabling / disabling of the touchpad
|
||||
- Enabling / disabling "natural scrolling" (reversed scrolling direction)
|
||||
- Touchpad speed
|
||||
- Enabling / disabling of Tap to Click
|
||||
|
||||
### Testing
|
||||
|
||||
You can test your settings by clicking the Test Your Settings button in the top right of the window.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
6
content/en/managing-your-system/configuring-network.md → content/configuration/configuring-network/en.md
Normal file → Executable file
6
content/en/managing-your-system/configuring-network.md → content/configuration/configuring-network/en.md
Normal file → Executable file
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
You can configure your network settings such as wireless networking, by going to the Budgie Menu, opening Settings, then clicking Network.
|
||||
|
||||
|
||||
|
||||
|
||||
To configure wireless, go to the Wi-Fi section. If your wireless is currently turned off, click the toggle button, leave the Network section, and go back in.
|
||||
|
||||
|
|
@ -10,7 +10,7 @@ To configure wireless, go to the Wi-Fi section. If your wireless is currently tu
|
|||
|
||||
Click the access point you wish to connect to.
|
||||
|
||||
|
||||
|
||||
|
||||
You may now be prompted to authenticate with the network. Type in your password and then click Connect.
|
||||
|
||||
|
|
@ -20,6 +20,6 @@ If your password is correct, you will now be authenticated with the network.
|
|||
|
||||
If you wish to connect to a hidden network, click “Connect to Hidden Network”. It will show the following dialog, where you type the SSID (name of the network) and type of security (if any).
|
||||
|
||||
|
||||
|
||||
|
||||
If the network is found and has a password, you will be prompted to authenticate with the network.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
|
|
@ -0,0 +1,15 @@
|
|||
## Configuring Sound and Sound Devices
|
||||
|
||||
You can configure sound devices, change volume and enable / disable devices through two methods.
|
||||
|
||||
### Raven
|
||||
|
||||
You can access sound settings via the Sound applet in Raven, our Notification and Widget Center.
|
||||
|
||||
|
||||
|
||||
### Settings
|
||||
|
||||
You can access further sound settings, including individual application volume controls, by going to the Budgie Menu, opening Settings, then clicking Sound.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
|
|
@ -0,0 +1,11 @@
|
|||
## Enabling Desktop Icons
|
||||
|
||||
You can enable desktop icons by opening Raven, clicking the cog wheel for Budgie Settings, then toggling Desktop Icons on under the Background section.
|
||||
|
||||
|
||||
|
||||
You may now add things to your Desktop by:
|
||||
1. Opening the file manager
|
||||
2. Moving the files you want to the Desktop folder (as shown in the image below).
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.0 KiB |
|
|
@ -0,0 +1,13 @@
|
|||
## Installing Proprietary Drivers
|
||||
|
||||
Installing proprietary drivers may improve performance or certain features, however they are usually not necessary for normal daily usage.
|
||||
|
||||
You can enable proprietary Broadcom or NVIDIA drivers by going to the Budgie Menu and opening Hardware Drivers.
|
||||
|
||||
|
||||
|
||||
If there are proprietary drivers that can be installed, they will show up in the box below the description. You can click the item you wish to install and click Install.
|
||||
|
||||
If you are installing NVIDIA drivers, you may find it to be desirable to install the 32-bit driver as well, in the event you wish to use Steam or WINE.
|
||||
|
||||
**Note:** A reboot will be required to use the newly installed driver.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
13
content/en/managing-your-system/managing-users.md → content/configuration/managing-users/en.md
Normal file → Executable file
13
content/en/managing-your-system/managing-users.md → content/configuration/managing-users/en.md
Normal file → Executable file
|
|
@ -1,11 +1,12 @@
|
|||
## Managing Users
|
||||
|
||||
In this section, we will be reviewing how to add and remove users on your Solus system. Before we begin, go to the Budgie Menu, open the Settings app, then go to Users.
|
||||
To add and remove users on your Solus system, go to the Budgie Menu, open the Settings app, then go to Users.
|
||||
|
||||
|
||||
|
||||
*Your window should look fairly similar to the one below.*
|
||||
|
||||
To manage your or other’s accounts, you first need to authenticate. Click the Unlock button in the top right corner and type the root password (if you are the only user, this is likely the same password you use to log in).
|
||||
To manage your or other’s accounts, you first need to authenticate. Click the Unlock button in the top right corner and type your password. Note that you are required to be an administrator. If you're the only user on
|
||||
the system, then your account is an administrator by default.
|
||||
|
||||
In the event it is correct, the Unlock button will change to Lock and the Add / Remove buttons will be clickable.
|
||||
|
||||
|
|
@ -13,14 +14,12 @@ In the event it is correct, the Unlock button will change to Lock and the Add /
|
|||
|
||||
To add a user, click the `+` button in the bottom left corner of the Users window. This will show the Add User window (shown below).
|
||||
|
||||
|
||||
|
||||
|
||||
### Removing a user
|
||||
|
||||
To remove a user, select the user under the “Other Accounts” section and click the `-` button.
|
||||
|
||||
|
||||
|
||||
Upon clicking the remove the user, you will be brought to the following window. In this window, you have the option to keep their files, delete the files, or cancel the removal of the user’s account.
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
|
|
@ -1,4 +0,0 @@
|
|||
# Advanced
|
||||
*We've build the engine. You get to tune it.*
|
||||
|
||||
<!-- Reference advanced/* contents. -->
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
## Delivering software on the system
|
||||
|
||||
Software is delivered for Solus through the Solus repository. In the event you wish to provide **open source** software via the repository, we provide a [Packaging Guide](https://wiki.solus-project.com/Packaging_Guide) to help get you started.
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
## Other Resources
|
||||
|
||||
- [Official website](https://solus-project.com/)
|
||||
- [Blog](https://solus-project.com/blog/)
|
||||
- [Solus Release Cycle](https://solus-project.com/release-cycle/)
|
||||
- [Solus wiki](https://wiki.solus-project.com/Main_Page)
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
## Using the Package manager
|
||||
|
||||
Solus uses the eopkg package management system to deliver software to the end-user. You can read about the package manager [here](https://wiki.solus-project.com/Package_Management).
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
# Common Tasks
|
||||
*Solus aims to make the everyday experience of computing easier.*
|
||||
|
||||
*We provide numerous applications out of the box to make your experience seamless.*
|
||||
|
||||
<!-- Reference common-tasks/* contents. -->
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
## Installing and updating software
|
||||
|
||||
|
||||
|
||||
You can install software (*such as the free office suite LibreOffice*) as well as updating software via our Software Center.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# First Boot
|
||||
|
||||
When you first boot up your new Solus system, you will be setting up your language and keyboard settings, your user account, and network settings.
|
||||
|
||||
<!-- Reference first-boot/* contents. -->
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
## Keyboard Layout
|
||||
|
||||
Select the language and layout for your keyboard. *You can change or add more later.*
|
||||
|
||||
|
||||
|
||||
If you do not find the correct keyboard layout, click the ⋮ button and type your language / keyboard layout like in the above image.
|
||||
|
||||
Upon finding and selecting the correct keyboard layout, click Next.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
## Language Selection
|
||||
|
||||
Select the language to use on your computer. *You can add more later.*
|
||||
|
||||
|
||||
|
||||
If the language is listed like above, click it. Otherwise click the ⋮ for more options. Then proceed by clicking the Next button in the top right corner.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
## Online Accounts
|
||||
|
||||
You have the option to connect your online accounts to easily access your calendar, contacts, documents, and more. This is an **optional** step and can always be done later via the Settings application.
|
||||
|
||||
|
||||
|
||||
In the interest of time, this guide will skip the Online Accounts creation. You can do as well by clicking the Skip button.
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
## Privacy
|
||||
|
||||
In this section, you have the option to disable Location Services. Location Services are used to determine your geographical location and are only used for specific applications.
|
||||
|
||||
|
||||
|
||||
``` tinynote
|
||||
Solus Project does not store use any of the location information provided by the system.
|
||||
Location Services is solely used by applications and provided by your desktop.
|
||||
```
|
||||
|
||||
After keeping it the same or disabling Location Services, click Next.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
## Ready to Go!
|
||||
|
||||
You're now ready to use your Solus system!
|
||||
|
||||
|
||||
|
||||
Click the "Start using Solus Operating System" button and you will be moved to the login screen to log in to your fresh system.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
## Set a password
|
||||
|
||||
We are now entering a password to secure our user account created in the previous step.
|
||||
|
||||
|
||||
|
||||
We recommend using a strong password that is:
|
||||
|
||||
- 8 characters or more.
|
||||
- A mix of lowercase, uppercase, and numbers.
|
||||
- Optionally punctuation.
|
||||
|
||||
As your password gets strong, the green progress bar fills up. So long as one green section is filled and your passwords match, you can click Next. But you should have it be as strong as possible!
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
## Timezone Selection
|
||||
|
||||
We are now choosing our timezone.
|
||||
|
||||
|
||||
|
||||
We attempt to automatically determine your current timezone, however in the event it is incorrect, you may select individual regions or type (*click the Search button*) your location to find the most relevant and close result.
|
||||
|
||||
After setting your timezone, click Next.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
## User Creation
|
||||
|
||||
We are now entering your name and username into the About You page. You can also choose an avatar by clicking image above the About You header.
|
||||
|
||||
|
||||
|
||||
After you have entered your name and username, proceed by clicking Next.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# Installing
|
||||
|
||||
This section will walk you through the installation of the Solus operating system.
|
||||
|
||||
<!-- Reference installing/* contents. -->
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
### Finishing
|
||||
|
||||
|
||||
|
||||
Upon getting to this screen, exit the Installer.
|
||||
|
||||
If you are using a DVD, proceed to eject the DVD and turn off your system. If you are using a USB, proceed to turn off your system and remove the USB.
|
||||
|
||||
Now turn on your system!
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
## Partitioning Your System
|
||||
|
||||
In this section, you will proceed to partition your system. This may mean the erasing of personal information on this system. If you are using a UEFI / EFI system, please follow the partitioning notes stated [here](https://wiki.solus-project.com/UEFI).
|
||||
|
||||
|
||||
**Note:** The above screenshot reflects an empty drive. Your drive may appear differently.
|
||||
|
||||
### Configuring Partitions
|
||||
|
||||
The next step will be to select the drive you wish to install Solus to. After clicking the appropriate drive, you will come across our partition manager system. Now click Launch Partition Manager. This will launch a new window with a program called GParted.
|
||||
|
||||
If your device contains data / is **not** empty, skip this step. If your drive contains **no data**, click on Device menu, then Create Partition Table. Click the dropdown next to Select new partition table type and click **gpt**. Now click Apply.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Next, right click on the “unallocated” row in the partition table (below the graph) and click New.
|
||||
|
||||
This will bring you to the Create new Partition window, where we will first create Swap.
|
||||
|
||||
``` tinynote
|
||||
What is Swap?
|
||||
Swap is disk space that is used to contain application’s resources
|
||||
in the event your system’s memory (RAM) is full.
|
||||
```
|
||||
|
||||
We recommend a default of 2GB (2048 MiB) for swap. Type “2048” into the “New size (MiB) section. Now click the “File system” dropdown and press “linux-swap”. Proceed by pressing Add.
|
||||
|
||||
|
||||
|
||||
Right click the unallocated row again and proceed to click Add (*you will not need to change anything*).
|
||||
|
||||
Now click the big green check box to format the drive to the way you partitioned it. After it is done, it will say “All operations successfully completed”. Click close. Then close the GParted window.
|
||||
|
||||
### Assigning Partititions
|
||||
|
||||
|
||||
|
||||
You should now see a screen such as this, showing the new partitions.
|
||||
|
||||
First, click the **swap** device and click “Assign as swap partition”.
|
||||
|
||||
After doing so, click the **second device (ext4)** and click “Assign as root partition”. Remember the device prefix (in the image above, it is `/dev/sdb`) and click Next.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
## Starting Installer
|
||||
|
||||
|
||||
|
||||
The first step to installing Solus is, naturally, starting the Installer. Click the down-arrow icon in the upper left corner of the screen, then proceed to click Install Solus.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
## System Settings and Bootloader
|
||||
|
||||
|
||||
|
||||
You will now come across a System settings section. This is where you type the name you wish to call your computer. Using the device from the preview screen (partitioning), click “Should we install a bootloader on this computer?” and then select that device.
|
||||
|
||||
Click next, review the Summary, then click Next if everything looks good!
|
||||
|
||||
It will now begin installation of Solus on your system! This may take some time.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
|
||||
|
||||
# User Guide
|
||||
|
||||
Welcome to the User Guide of the Solus Project's Solus Operating System.
|
||||
This guide will walk you through the installation and usage of Solus.
|
||||
|
||||
*Release 1 - January 10th, 2015*
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
# Managing your system
|
||||
|
||||
<!-- Reference managing-your-system/* contents. -->
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
## Changing Background
|
||||
|
||||
|
||||
|
||||
You can change your background by going to the Budgie Menu, opening Settings, then clicking Background.
|
||||
|
||||
You will have two options, Background and Lock Screen. Select Background.
|
||||
|
||||
In this section, you can choose between predefined wallpapers,pictures in your Pictures folder, or solid colors. After choosing, click Select.
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
## Configuring Keyboard Layout
|
||||
|
||||
You can change your language by going to the Budgie Menu, opening Settings, then clicking Region and Language.
|
||||
|
||||
You will now be shown the following dialog.
|
||||
|
||||
|
||||
|
||||
Click the `+` button to add an input source (keyboard layout). You will be shown the following dialog.
|
||||
|
||||
|
||||
|
||||
Here, you can select the language and then keyboard layout within each language section. If it does not appear in this list, click the ⋮ button. This will enable you to search for the keyboard layout you wish to use.
|
||||
|
||||
After choosing the keyboard layout, click Done. You will be brought back to the following dialog with your new keyboard layout. In the image below, we are now using English (US) and Finnish layout.
|
||||
|
||||
|
||||
|
||||
You can remove a keyboard layout by click on one of the items, for instance Finnish, then clicking the `-` button.
|
||||
|
||||
If you wish to use multiple keyboard layouts, you can switch to them by using: `Windows key + Space`
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
## Configuring Mouse and Touchpad
|
||||
|
||||
You can configure the settings of your mouse and/or touchpad by going to the Budgie Menu, opening the Settings app, then clicking the Mouse & Touchpad section. You will be presented with the following window.
|
||||
|
||||
|
||||
|
||||
In this window, you can set if you want your primary button (usually left click) to be left or right, speed of double-clicking, and individual pointer speeds for mouse and touchpad.
|
||||
|
||||
You can also toggle Tap to click (click via touchpad), two-finger scrolling, and “natural scrolling” (reversed scrolling directions).
|
||||
|
||||
You can also test your settings by clicking the Test Your Settings button in the top right of the window.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
## Configuring Sound and Sound Devices
|
||||
|
||||
You can configure sound devices, change volume and enable / disable devices through two methods.
|
||||
|
||||
### Raven
|
||||
|
||||
` special-formatting: image-float-left`
|
||||
|
||||
|
||||
|
||||
` end-special-formatting `
|
||||
|
||||
You can access sound settings via the Sound applet in Raven. Please consult the Raven section of Using Desktop for information on access Raven.
|
||||
|
||||
### Settings
|
||||
|
||||
|
||||
|
||||
You can access further sound settings, including individual application volume controls, by going to the Budgie Menu, opening Settings, then clicking Sound.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
## Enabling Desktop Icons
|
||||
|
||||
You can enable desktop icons by going to the Budgie Menu and typing Tweak Tools. After opening Tweak Tools, go to the Desktop section.
|
||||
|
||||
|
||||
|
||||
From the desktop section, click the toggle button to the right of Icons on Desktop. You can also choose what is automatically shown on the desktop.
|
||||
|
||||
You may now add things to your Desktop by:
|
||||
1. Opening the file manager
|
||||
2. Moving the files you want to the Desktop folder (as shown in the image below).
|
||||
|
||||
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
## Enabling Proprietary Drivers
|
||||
|
||||
Enabling proprietary drivers may improve performance or certain features, however they are usually not necessary for normal daily usage.
|
||||
|
||||
You can enable proprietary AMD and Nvidia drivers by going to the Budgie Menu and opening Hardware Drivers.
|
||||
|
||||
|
||||
|
||||
If there are proprietary drivers that can be installed, they will show up in the box below the description. You can click the item you wish to install and click Install. A reboot will be required to use the newly installed driver.
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
## Other System settings
|
||||
|
||||
You can access other system settings via the Settings app. Below is a table of commonly changed system settings and their location in the Settings app.
|
||||
|
||||
Action | Location
|
||||
----- | -----
|
||||
Configuring Bluetooth Devices | Bluetooth
|
||||
Configuring Wacom Tablets | Wacom Tablet
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Preface
|
||||
|
||||
Solus is built by contributors volunteering their time and resources to create this free and open source operating system. We are grateful for everyone’s contributions and love to continuously provide support and improve Solus.
|
||||
|
||||
If you feel you have benefited from the use of Solus, we encourage you to help support the Solus Project and our mission.
|
||||
|
||||
To see how you can support the project, go to:
|
||||
|
||||
[https://solus-project.com/support/](https://solus-project.com/support/)
|
||||
|
||||
Sincerely,
|
||||
|
||||
Solus Project Team
|
||||
|
||||
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
# Using The Desktop
|
||||
|
||||
|
||||
*Designed with the modern user in mind, our desktop environment focuses on simplicity and elegance.*
|
||||
|
||||
<!-- Reference using-the-desktop/* contents. -->
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
## About Budgie
|
||||
|
||||
Budgie is the flagship desktop environment of the Solus Operating System. It is designed with the modern user in mind, it focuses on simplicity and elegance, while being powerful and customizable enough to make it your own.
|
||||
|
||||
### Accessibility
|
||||
|
||||
Budgie has been tested and refined to ensure High Contrast theming works out-of-the-box and enabling usage by individuals with visual impairments.
|
||||
|
||||
### Budgie Menu
|
||||
|
||||
` special-formatting: image-float-left`
|
||||
|
||||
` end-special-formatting`
|
||||
|
||||
This menu enables quick access to your installed programs and offers category and compact views.
|
||||
|
||||
### Raven
|
||||
|
||||
` special-formatting: image-float-left`
|
||||
|
||||
` end-special-formatting`
|
||||
|
||||
Budgie ships with an applet, notification and customization center referred to as Raven. Raven enables you to:
|
||||
|
||||
1. Easily access calendar information, sound volume, media player controls, and more via Applets view.
|
||||
2. Manage incoming application and system notifications via Notifications view
|
||||
3. Customize your Budgie and system experience by enabling you to:
|
||||
1. Toggle system-wide Dark theme.
|
||||
2. Change GTK and icon theming
|
||||
3. Add, remove, and modify Budgie panels, their properties as well as their displayed applets.
|
||||
4. Obtain quick access to system settings and power options such as restart, suspend, and shutdown.
|
||||
|
||||
You can access Raven by clicking the status icons (such as notification bell) in the top right corner of the screen or via the Keyboard Shortcut stated below.
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
We provide numerous keyboard shortcuts to enable quick access to areas of the Budgie desktop.
|
||||
|
||||
Keyboard Shortcut | Action
|
||||
----- | -----
|
||||
Windows Key (*also Windows key + S*) | Open Budgie Menu
|
||||
Windows Key + N | Open Raven
|
||||
|
||||
### Budgie Settings
|
||||
|
||||
` special-formatting: image-float-left`
|
||||
|
||||
` end-special-formatting`
|
||||
|
||||
You can customize your Budgie desktop experience via Raven. Click the cog wheel icon when you have Raven open.
|
||||
|
||||
In the Budgie Settings “General” section, you can choose to use a global Dark theme, “widget” theme, and icon theming.
|
||||
|
||||
` special-formatting: image-float-left`
|
||||
|
||||
` end-special-formatting`
|
||||
|
||||
In the Budgie Settings “Panel” section, you can choose:
|
||||
- If you wish for the panel (where running applications, clock, etc. are shown) to be on the top or bottom of the screen
|
||||
- How tall the panel is and whether it has a shadow.
|
||||
- The positioning of individual “applets” (like the clock).
|
||||
- Individual sections for applets (click on the Icon Task List applet as an example and see the cog wheel light up.)
|
||||
- Sometimes individual applets have further customization options! The Icon Task List enables you to enlarge the icons, for example.
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
# Basics to eopkg
|
||||
|
||||
Solus uses the eopkg package management system to deliver software to the end-user.
|
||||
Below are some basic commands for using eopkg.
|
||||
|
||||
## Installing Software
|
||||
|
||||
You can install one or more packages by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg install packagename
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg install gnome-documents gnome-music
|
||||
```
|
||||
|
||||
## Reinstalling Software
|
||||
|
||||
You can reinstall one or more packages by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg install --reinstall packagename
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg install --reinstall gnome-documents gnome-music
|
||||
```
|
||||
|
||||
## Uninstalling Software
|
||||
|
||||
You can uninstall one or more packages by using:
|
||||
|
||||
```
|
||||
sudo eopkg remove packagename
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg remove gnome-documents gnome-music
|
||||
```
|
||||
|
||||
### Get Information on Software
|
||||
|
||||
You can get information on software, such as its description, version, installation size, and more, by using
|
||||
|
||||
``` bash
|
||||
sudo eopkg info packagename
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg info gnome-documents
|
||||
```
|
||||
|
||||
## Updating
|
||||
|
||||
You can update your system by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg upgrade
|
||||
```
|
||||
|
||||
If you want to **only** update a specific piece of software on your system, you can specify is like below:
|
||||
|
||||
``` bash
|
||||
sudo eopkg upgrade firefox
|
||||
```
|
||||
|
||||
## Searching
|
||||
|
||||
You can search the software selection Solus provides by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg search term
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg search documents
|
||||
```
|
||||
|
||||
Notice that you don't need to search for a specific software name, although you can do that. We search
|
||||
summaries and software names by default.
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# History and Software Rollback
|
||||
|
||||
Solus provides a history and rollback feature via its package manager,
|
||||
eopkg. This feature allows you to see when your repository was last
|
||||
updated, actions such as installation, removal, and upgrading of software.
|
||||
|
||||
Our rollback feature allows you to essentially rewind your system's software back
|
||||
to a previous state, assuming you or our repository has the versions in question.
|
||||
|
||||
## History
|
||||
|
||||
You can see the history from eopkg by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg history
|
||||
```
|
||||
|
||||
## Rollback
|
||||
|
||||
To rollback your system, first use the above history command to check what the
|
||||
transaction / operation number was. Then, we use the following command:
|
||||
|
||||
``` bash
|
||||
sudo eopkg history -t number
|
||||
```
|
||||
|
||||
The number, in this case, is the operation before the one you want to change. So if
|
||||
the number was `100`, then you would use `99`.
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
# Repository Management with eopkg
|
||||
|
||||
While Solus currently only provides two repositories, stable (shannon) and stable, our
|
||||
package manager does support actively using multiple repositories on your system. This
|
||||
is useful if you are using a vendor-provided repository.
|
||||
|
||||
## Adding a Repository
|
||||
|
||||
You can add a repository by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg add-repo Name Url
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg add-repo Example http://example.com/repo/eopkg-index.xml.gz
|
||||
```
|
||||
|
||||
**Note:** This does not enable the repository.
|
||||
|
||||
## Removing a Repository
|
||||
|
||||
You can remove a repository by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg remove-repo Name
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg remove-repo Example
|
||||
```
|
||||
|
||||
## Enabling a Repository
|
||||
|
||||
You can enable a repository for usage, by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg enable-repo Name
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg enable-repo Example
|
||||
```
|
||||
|
||||
## Disabling a Repository
|
||||
|
||||
You can disable a repository by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg disable-repo Name
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg disable-repo Example
|
||||
```
|
||||
|
||||
## Updating a Repository
|
||||
|
||||
You can update the index of a repository by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg update-repo Name
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
``` bash
|
||||
sudo eopkg update-repo Example
|
||||
```
|
||||
|
||||
**Note:** You can update all repository by **not** providing a name.
|
||||
|
||||
## List repositories
|
||||
|
||||
You can list all the repositories added on your system by using:
|
||||
|
||||
``` bash
|
||||
sudo eopkg list-repo
|
||||
```
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 332 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 115 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 112 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue