Add linux config

[rbdr/lyricli] / README.md

diff --git a/README.md b/README.md
index 6d6046aee9c308e86f5e61f8ea96ee750aad353a..f4d969a991ccbfb27be73527b6e02e299fc3088b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,45 +42,25 @@ And you can print the help or the version:
 
 ## Building
 
 
 ## Building
 

-The build has only been tested on OSX using Swift 5.8 Building defaults
-to the debug configuration.
+In order to build this project, you'll need a genius client token. See
+the [genius api docs][genius_api_docs] for more information.

 
 

-```
-make
-```
-
-## Installing from source
+The Makefile will read the values from a `.env` file, so you can copy the
+`env.dist` file and fill the values there.

 
 

-Builds lyricli in release configuration and copies the executable as
-`lrc` to `/usr/local/bin`
+You can build for development just by running make. You can specify the
+profile using the profile environment value `-e profile=release`.

 
 ```
 
 ```

-make install
-```
-
-### Installing to a custom directory
-
-This can be done by overriding the `install_path` variable
+# Build for dev
+make

 
 

+# Build for release
+make -e profile=release

 ```
 ```

-make install install_path=/opt/bin
-```
-
-## Linting and Generating Documentation
-
-We use [swiftlint][swiftlint] to lint, and `make lint` to run it.
-We use [jazzy][jazzy] and [SourceKitten][sourcekitten] to document, and
-`make document` to generate it.

 
 

-## Running tests
+### Additional Dependencies

 
 

-No tests at the moment 😬... but the makefile is mapped to run the swift
-tests.
-
-```
-make test
-```
+On linux you might need to install the libssl-dev and libdbus-dev

 
 

-[swiftlint]: https://github.com/realm/SwiftLint
-[jazzy]: https://github.com/realm/jazzy
-[sourcekitten]: https://github.com/jpsim/SourceKitten
+[genius_api_docs]: https://docs.genius.com/