Skip to content

Commit

Permalink
documentation updated & cmake bug fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
aliereny committed Aug 15, 2021
1 parent 18a0485 commit 7e1c71b
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.1
0.1.2
24 changes: 23 additions & 1 deletion BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,30 @@ cmake -S fastfingers/src -B fastfingers/src/build -DCMAKE_BUILD_TYPE=Release
cmake --build fastfingers/src/build --config Release
```

### Install System-wide
### *Install System-wide _(Optional)_

If you want to install the application system-wide, you can run the following command. This step requires root
permission to install binaries, desktop files and icons.

```bash
sudo cmake --build fastfingers/src/build --target install
```

## Run the FastFingers and Cheatsheet

### Run from the build directory

**Run FastFingers**

```bash
fastfingers/src/build/fastfingers
```

**Run Cheatsheet**

```bash
fastfingers/src/build/fastfingers-cheatsheet
```

**NOTE** You can add "{installation path}/fastfingers/src/build" to your PATH environment variable so that you can start
FastFingers and Cheatsheet from any directory.
12 changes: 2 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ case characters and shouldn't contain any whitespace.
{
"title": "Firefox",
"category": "Utility",
"recent": [],
"group": [
...
]
Expand All @@ -62,8 +61,6 @@ case characters and shouldn't contain any whitespace.
* This key determines the title of the application. This is the name shown in the FastFingers for the application.
* category
* This key determines the category of the application. On the home page, the applications are grouped under categories, so this information is important for harmony.
* recent
* This key is used in the application run time. It should be left blank in the source.
* group
* Shortcuts of the applications are stored under the categories, and the group key has an array value that holds those categories.

Expand Down Expand Up @@ -91,17 +88,14 @@ case characters and shouldn't contain any whitespace.
"keys": [
"Alt",
"Left"
],
"learned": 0
]
}
```

* title
* Title is the both identifier and descriptor of the shortcut. In practice, quiz, and quiz result screens, this title is shown. Thi title should be as short as possible.
* keys
* Keys that should be pressed are stored in this array in the same order.
* learned
* Learned key is meaningful for the program and this key should be 0 in the source files.

#### Finalizing

Expand All @@ -111,7 +105,6 @@ After following the steps above, you should have a JSON structure like this:
{
"title": "Firefox",
"category": "Utility",
"recent": [],
"group": [
{
"title": "Navigation",
Expand All @@ -121,8 +114,7 @@ After following the steps above, you should have a JSON structure like this:
"keys": [
"Alt",
"Left"
],
"learned": 0
]
}
]
}
Expand Down
15 changes: 15 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
Version 0.1.2
~~~~~~~~~~~~~
Released: 2021-8-15

* Information text added when the quiz button is invisible
* Quiz page timer fixed (it wasn't working in the last question)
* Correct keys are shown when user makes wrong combo in quiz screen
* After quiz ends, users can retry to solve failed questions
* System-wide installation made optional, users don't have to grant root permission
* Application files are moved to /home/user/.fastfingers path
* Run-time related properties in the application files are removed
* IDs are generated for questions and categories
* Documentation updated
* Error messages have the file and line number

Version 0.1.1
~~~~~~~~~~~~~
Released: 2021-8-14
Expand Down
4 changes: 2 additions & 2 deletions src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ file(
add_desktop(fastfingers ${CMAKE_PROJECT_VERSION})

file(
COPY ${CMAKE_BINARY_DIR}/org.ccextractor.FastFingers.desktop
COPY ${CMAKE_BINARY_DIR}/org.ccextractor.Cheatsheet.desktop
DESTINATION "$ENV{HOME}/.fastfingers/model"
FILE_PERMISSIONS
OWNER_READ OWNER_WRITE
Expand All @@ -119,7 +119,7 @@ install(
WORLD_READ WORLD_EXECUTE)

install(
FILES
FILESCheatsheet
${CMAKE_BINARY_DIR}/org.ccextractor.FastFingers.desktop
${CMAKE_BINARY_DIR}/org.ccextractor.Cheatsheet.desktop
DESTINATION
Expand Down

0 comments on commit 7e1c71b

Please sign in to comment.