Update the readme with some setup info

Sat Mar 15 2025

tucker.mcknight@gmail.com


    

3f91b67f74e11fcbba27177dd375f49959c783ef

darcs pull https://repos.tuckerm.us/repos/eleventy-darcs/branches/main -h 3f91b67f74e11fcbba27177dd375f49959c783ef
README.md:8
Before
After
### General info

This project creates pages for vieweing the files and patches inside of a darcs repository. It uses the Eleventy
static site generator ([11ty.dev](https://11ty.dev)) to do so.

#### Installation and Setup

1. Have [darcs](https://darcs.net) installed
2. Have nodejs installed
3. Clone this repository
   ```
   darcs clone https://repos.tuckerm.us/repos/eleventy-darcs
   ```
4. Edit `darcsconfig.js`, changing the objects under `repos` to be your local repositories that you want to create a repo viewer for.
README.md:27
Before
After
- [ ] Turn this into an 11ty *plugin* so that people can add this repo viewer to their existing 11ty blog, instead of having to be its own separate website
_data/darcsConfig.js:1
Before
After
import darcsConfig from '../darcsconfig.js'

export default () => {
  return {
    baseUrl: darcsConfig.baseUrl,
  }
}
darcsconfig.js:3
Before
    "eleventy-darcs": { location: "./" 
After
    "my-repository": { // <-- Edit this to be the name of your local repository
      location: "./relative/path/to/repo" // <-- Make this the relative path to that repository.
                                          //     You might want a "../" at the beginning to go up
                                          //     one directory.
darcsconfig.js:8
Before
"thielema-youtube": {
location: "../youtube",
    },
  }
After
//  "another-repository": {
//    location: "./another/relative/path"
//  },
  },
  baseUrl: "http://localhost:8080", // <-- Change this to your deployed domain
                                    //     if this site is public.