Skip to content

Commit 1678cab

Browse files
committed
Update README.md
1 parent 893048a commit 1678cab

17 files changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LAFS
22

3-
A digital archive for a Landscape Architecture Film Series website from the early aughts
3+
A digital archive of the Landscape Architecture Film Series website from the early aughts
44

55
## Table of Contents
66

@@ -38,7 +38,7 @@ This repository preserves a sentimental piece of personal digital history. What
3838

3939
To learn how this project came about, check out [_LAFS-DEV_](https://github.com/ggeerraarrdd/lafs-dev).
4040

41-
![Film Series](/docs/images/film-series1_2.jpg "Landscape Architecture Film Series")
41+
![LAFS](/assets/images/film-series1_2.jpg "Landscape Architecture Film Series")
4242

4343
## Target Users
4444

@@ -59,7 +59,7 @@ _LAFS_ is intended for:
5959
## Project Structure
6060

6161
```text
62-
film-series/
62+
lafs/
6363
6464
├── app/
6565
│ │
@@ -99,26 +99,25 @@ film-series/
9999

100100
## Quick Start
101101

102-
For developers familiar with Python environments who want to quickly get _LAFS_ running, this one-command setup will launch the development server with default settings:
102+
For those who want to get up and running quickly with default settings:
103103

104104
```bash
105-
# Clone the repository
105+
# Clone the repo
106106
git clone https://github.com/ggeerraarrdd/lafs.git
107-
108-
# Setup environment and install dependencies
109107
cd lafs
110-
python -m venv venv
108+
109+
# Set up environment and install dependencies
110+
python3 -m venv venv
111111
source venv/bin/activate # On Windows use `venv\\Scripts\\activate`
112112
pip install -r requirements.txt
113113

114114
# Run the application
115115
flask run
116116

117-
# Access the website
118-
# Copy the URL displayed in the terminal after 'Running on' and open in your browser
117+
# Navigate to the URL specified in the terminal output
119118
```
120119

121-
### Local Setup
120+
## Local Setup
122121

123122
### Prerequisites
124123

@@ -133,19 +132,21 @@ flask run
133132
1. **Clone the repository**
134133

135134
```bash
136-
git clone https://github.com/ggeerraarrdd/film-series.git
135+
git clone https://github.com/ggeerraarrdd/lafs.git
136+
cd lafs
137137
```
138138

139-
2. **Create and activate a virtual environment**
139+
2. **Create and activate a Python virtual environment**
140140

141141
```bash
142-
python -m venv venv
142+
python3 -m venv venv
143143
source venv/bin/activate # On Windows use `venv\Scripts\activate`
144144
```
145145

146146
3. **Install the dependencies**
147147

148148
```bash
149+
python -m pip install --upgrade pip
149150
pip install -r requirements.txt
150151
```
151152

@@ -245,7 +246,7 @@ flask run
245246

246247
### Release Notes
247248

248-
* See [https://github.com/ggeerraarrdd/film-series/releases](https://github.com/ggeerraarrdd/film-series/releases)
249+
* See [https://github.com/ggeerraarrdd/lafs/releases](https://github.com/ggeerraarrdd/lafs/releases)
249250

250251
### Initial Release
251252

@@ -257,7 +258,7 @@ The [original website](https://web.archive.org/web/20040827234527/http://www.reh
257258

258259
## License
259260

260-
* [MIT License](https://github.com/ggeerraarrdd/film-series/blob/main/LICENSE)
261+
* [MIT License](https://github.com/ggeerraarrdd/lafs/blob/main/LICENSE)
261262

262263
## Contributing
263264

@@ -269,13 +270,13 @@ This project is not accepting contributions at this time. It is intended solely
269270
270271
## Screenshots
271272
272-
![Film Series](/docs/images/film-series0_2.png "Landscape Architecture Film Series")
273+
![LAFS](/docs/images/film-series0_2.png "Landscape Architecture Film Series")
273274
_(Image created using [Portfoliofy](https://github.com/ggeerraarrdd/portfoliofy).)_
274275
275-
![Film Series](/docs/images/film-series2_2.jpg "Landscape Architecture Film Series")
276-
![Film Series](/docs/images/film-series3_2.jpg "Landscape Architecture Film Series")
277-
![Film Series](/docs/images/film-series4_2.png "Landscape Architecture Film Series")
278-
![Film Series](/docs/images/film-series5_2.png "Landscape Architecture Film Series")
276+
![LAFS](/assets/images/film-series2_2.jpg "Landscape Architecture Film Series")
277+
![LAFS](/assets/images/film-series3_2.jpg "Landscape Architecture Film Series")
278+
![LAFS](/assets/images/film-series4_2.png "Landscape Architecture Film Series")
279+
![LAFS](/assets/images/film-series5_2.png "Landscape Architecture Film Series")
279280
280281
## Frontispiece
281282
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)