aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNunoSempere <nuno.sempere@protonmail.com>2023-03-28 11:42:59 -0600
committerNunoSempere <nuno.sempere@protonmail.com>2023-03-28 11:42:59 -0600
commit0b9386f5fe85f3dcb8dff26d0256e1972e755cde (patch)
treefd7edab7ee0604bc3d6685e04166b1b4445ceade /README.md
parent20d0becba9746b11a0696240dc9eab6fabf15d80 (diff)
chore: add installation section to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 04edaea..e0d61df 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,17 @@ You can see some screenshots in the [screenshots](./screenshots) folder.
- Custom style: Override the css of predetermined websites
- Stand in plugin: Mimick function definitions which do nothing for the above plugins so that they can be quickly removed
+### Installation
+
+Install dependencies, then:
+
+```
+make build
+make install # or sudo make install
+```
+
+You can also see more detailed instructions [here](./user-scripts/ubuntu-20.04/install-with-dependencies.sh), for Ubuntu 20.04 in particular—though they should generalize trivially.
+
### 👐 Contribute
- Contribute upstream to [github.com/mini-rose/rose](https://github.com/mini-rose/) for core functionality changes.