Update README to include specification.txt information
This commit is contained in:
parent
7b730e0d8b
commit
311064ad09
10
README.md
10
README.md
|
|
@ -4,16 +4,18 @@ This repository contains the project implementation based on the provided specif
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
|
|
||||||
- `specification.html` - Project specification document
|
- `specification.html` - Project specification document (HTML format)
|
||||||
|
- `specification.txt` - Information about the specification format
|
||||||
- `src/` - Source code for the project
|
- `src/` - Source code for the project
|
||||||
- `tests/` - Test files
|
- `tests/` - Test files
|
||||||
- `config/` - Configuration files
|
- `config/` - Configuration files
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
1. Review the specification in `specification.html`
|
1. Review the specification in `specification.html` (requires JavaScript execution in browser)
|
||||||
2. Set up development environment
|
2. Read `specification.txt` for information about the specification format
|
||||||
3. Start implementing features according to the specification
|
3. Set up development environment
|
||||||
|
4. Start implementing features according to the specification
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue