Преглед на файлове

Merge pull request #21 from ArcoMul/add-dev-instructions-to-readme

Add development instructions to README + fix .gitignore
Daoud Clarke преди 3 години
родител
ревизия
0b7bc90a05
променени са 2 файла, в които са добавени 11 реда и са изтрити 1 реда
  1. 1 1
      .gitignore
  2. 10 0
      README.md

+ 1 - 1
.gitignore

@@ -1,4 +1,4 @@
-./data
+/data
 .idea
 *~
 

+ 10 - 0
README.md

@@ -111,3 +111,13 @@ If you would like to help in any of these or other ways, thank you!
 Please join our [Matrix chat
 server](https://matrix.to/#/#mwmbl:matrix.org) or email the main
 author (email address is in the git commit history).
+
+Development
+===========
+
+Using Docker:
+
+1. Create a new folder called `data` in the root of the repository
+2. Download the [index file](https://storage.googleapis.com/mwmbl/index.tinysearch) and place it the new data folder
+3. Run `$ docker build . -t mwmbl`
+4. Run `$ docker run -p 8080:8080 mwmbl`