Skip to content

Commit 3f3f38d

Browse files
docs: Updated readme instructions for windows (#73)
Added additional instructions in the Readme based on issues encountered during installation on Windows. Specifically creating a new .env file and handling version mismatching.
1 parent f2ff0e5 commit 3f3f38d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ This will clone the repository from GitHub. Once cloned, navigate into the new d
2525
cd kos-base
2626
```
2727

28+
#### 1.5. Environment Variables
29+
As part of the repository we have an example environment file with a '.example' extension.
30+
Create a copy of this file with the example extension removed.
31+
32+
'''shell
33+
cp .env.example .env
34+
'''
35+
2836
#### 2. Build Docker image
2937
Files provided in the repository are pre-configured to build Kos from the application source code previously cloned in the last step. The Kos Docker image is built in steps. Once each step completes, it's stored in a cache for later to speed up following builds.
3038

@@ -33,6 +41,9 @@ To build the application image, run:
3341
docker compose build
3442
```
3543

44+
If the build fails, the composer dependencies may be out of date.
45+
A short term solution is to delete the "composer.lock" file.
46+
3647
#### 3. Run Kos
3748
With the application image built, we can now stand up Kos with necessary dependencies. To run Kos, run:
3849
```shell

0 commit comments

Comments
 (0)