Skip to content

Commit

Permalink
AUTHORS, BUILDING.md, NEWS and README.md files are added and updated
Browse files Browse the repository at this point in the history
  • Loading branch information
aliereny committed Aug 14, 2021
1 parent e940ba6 commit 58f0f10
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 39 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ali Eren Yogurtcu <[email protected]>
69 changes: 69 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Building FastFingers From Source

FastFingers uses the [CMake](https://cmake.org/) and
[GNU Make](https://www.gnu.org/software/make/) build tools.
Along with these tools, some libraries needs to be installed
to build FastFingers from the source. In the section below
these dependencies are described.

## Table of contents
- [Building FastFingers From Source](#building-fastfingers-from-source)
* [Dependencies](#dependencies)
+ [Install Dependencies for Ubuntu/Debian](#install-dependencies-for-ubuntu-debian)
+ [Install Dependencies for Fedora/CentOS](#install-dependencies-for-fedora-centos)
+ [Install Dependencies for Arch/Manjaro](#install-dependencies-for-arch-manjaro)
* [Building and Installing](#building-and-installing)
+ [Configure the CMake](#configure-the-cmake)
+ [Compile the source files](#compile-the-source-files)
+ [Install System-wide](#install-system-wide)

## Dependencies

To build FastFingers you need to install following libraries:

* GTK3
* CMake
* pkg-config
* A C compiler (Like GCC)
* A build system (Like GNU Make or Ninja)

You can install the required libraries and tools from package repositories:

### Install Dependencies for Ubuntu/Debian


```bash
sudo apt-get install build-essential cmake libgtk-3-0 libgtk-3-dev
```

### Install Dependencies for Fedora/CentOS

```bash
sudo dnf install make gcc cmake pkg-config gtk3 gtk3-devel
```


### Install Dependencies for Arch/Manjaro


```bash
sudo pacman -S base-devel gtk3 cmake
```

## Building and Installing


### Configure the CMake
```bash
cmake -S fastfingers/src -B fastfingers/src/build -DCMAKE_BUILD_TYPE=Release
```

### Compile the source files
```bash
cmake --build fastfingers/src/build --config Release
```

### Install System-wide
```bash
sudo cmake --build fastfingers/src/build --target install
```
11 changes: 9 additions & 2 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# FastFingers
Version 0.1.1
~~~~~~~~~~~~~
Released: 2021-8-14

Still under development
Initial release

Current applications:
- Firefox
- GIMP
- Postman
61 changes: 24 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,41 @@
# FastFingers App
# FastFingers &middot; [![GitHub license](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/CCExtractor/fastfingers/blob/main/LICENSE) [![Release Version](https://img.shields.io/github/v/release/CCExtractor/fastfingers)](https://github.com/CCExtractor/fastfingers/releases) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/CCExtractor/fastfingers/CMake/main) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/CCExtractor/fastfingers/blob/main/CONTRIBUTING.md)

FastFingers is an open-source application that helps its users to remove the habit of using a mouse, by helping them to memorize the shortcuts they want to learn.
FastFingers is an open-source application that helps its users to remove the habit of using a mouse, by helping them to
memorize the shortcuts they want to learn.

## Dependencies
**GTK 3 (see: https://www.gtk.org/docs/installations/linux/)**
* **Arch:** gtk3
* **Debian/Ubuntu:** libgtk-3-0 and libgtk-3-dev (Both are required to build from source!)
* **Fedora:** gtk3 and gtk3-devel (Both are required to build from source!)
## Table of contents
* [Installation](#installation)
* [Documentation](#documentation)
* [Contributing](#contributing)
* [License](#license)

**CMake**
* **Arch, Debian/Ubuntu, Fedora:** CMake
## Installation

**pkg-config**
* **Debian/Ubuntu:** pkg-config
FastFingers release Debian, Arch and RPM packages in every release. You can download the proper package for your Linux
system from releases and install them with package managers. For detailed information, read the
[Installation Page](https://github.com/CCExtractor/fastfingers/blob/main/INSTALLATION.md).

A C compiler and build tool, such as GCC and GNU Make or Ninja.
You can also build the FastFingers from the source code. For detailed information, see
the [Building Page](https://github.com/CCExtractor/fastfingers/blob/main/BUILDING.md).

## Building and Installing
###### FastFingers is planned to be published on the Snap Store soon.

Download the source code and move to the source directory
## Documentation

```bash
git clone https://github.com/aliereny/fastfingers.git
```
Configure the CMake
For users, installation and building steps are described in detail in the section above.

```bash
cmake -S fastfingers/src -B fastfingers/src/build -DCMAKE_BUILD_TYPE=Release
```

Build

```bash
cmake --build fastfingers/src/build --config Release
```

Install

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

The apps are ready to run. The apps should be installed in the applications sections of your desktop environment where you can run them from. Also you can run them from the commands "fastfingers" and "fastfingers-cheatsheet"

https://youtu.be/6ckgOJjpszU
FastFingers is a Linux GUI application. Main libraries and tools used in the project are GTK3, GLib, CMake and cJSON.
The application data is stored in JSON files. If you want to learn about the design, please read the
[Contributing Page](https://github.com/CCExtractor/fastfingers/blob/main/CONTRIBUTING.md)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

For more details, see the [Contributing Page](https://github.com/CCExtractor/fastfingers/blob/main/CONTRIBUTING.md)

## License

[GPL-2.0 License](https://github.com/CCExtractor/fastfingers/blob/main/LICENSE)

0 comments on commit 58f0f10

Please sign in to comment.