Эх сурвалжийг харах

Update README with clearer instructions

Hwurzburg 4 жил өмнө
parent
commit
d76da42f06
1 өөрчлөгдсөн 13 нэмэгдсэн , 8 устгасан
  1. 13 8
      README.md

+ 13 - 8
README.md

@@ -6,10 +6,16 @@ This is a website that generates a downloadable custom ArduPilot firmware, based
 Website: https://custom.ardupilot.org  
 Blog post: https://discuss.ardupilot.org/t/gsoc-2021-custom-firmware-builder/74946
 
-## For developers
+## How to build the server locally for testing
+
+It is expected that you have an environment where ArduPilot can be built. Otherwise, see [https://ardupilot.org/dev/docs/building-setup-linux.html](https://ardupilot.org/dev/docs/building-setup-linux.html).
+
+1. Fork and Clone the ArduPilot/CustomBuild repository
+
+2. In the directory containg the CustomBuild repo just cloned, create a /base subdirectory and change to that directory.
+
+3. Clone a fork of the ArduPilot/ardupilot repository. The structure should appear similar to that below:
 
-This website uses the Flask library. Flask must be installed before use.  
-Directories: `ardupilot` must be within `base`, which must be in the same directory as `CustomBuild`.
 
 ### Directory structure
 default directory structure is as follows
@@ -19,23 +25,22 @@ default directory structure is as follows
 -base
 --ardupilot
 ```
-
-Use `--basedir` to adjust the base directory, the default one is `base`.
-It is expected that you have an environment where ArduPilot can be built. Otherwise, see [https://ardupilot.org/dev/docs/building-setup-linux.html](https://ardupilot.org/dev/docs/building-setup-linux.html)
-
 ### Install Flask
 ```
 python3 -m pip install --user -U flask
 ```
+Use `--basedir` to adjust the base directory, the default one is `base`.
 
 ### Running
-To run:
+To run, in the CustomBuild directory execute the following command:
 
 ```
 ./app.py
 ```
+Once running, you will be given a link to a local host port in which the interface is displayed for the build server. It can be run at this point. Output will NOT be accessible via the interface buttons for build directory. Builds are stored in the base/builds subdirectory
 
 ### For Apache web server on Ubuntu with WSGI
+To create a full server with network access:
 
 * Install mod_wsgi for python 3:
 ```