Skip to content

Commit fed9b10

Browse files
authored
Ian/expand readme (#27)
* add acep banner, add readme sections * update readme * change spacing of logos * further changes to logo spacing * add methodology, move logos to bottom
1 parent 0e128d4 commit fed9b10

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1-
# Welcome
21

3-
This repository contains code and data in order to deploy a static Hugo site for energy burden in Fairbanks North Star Borough.
42

5-
## Hugo
6-
In order to develop and run locally, install Hugo on your machine by following [this link](https://gohugo.io/installation/). Once you have Hugo installed, clone the repo, nagivate to the root directory, and run `hugo serve` in order to start the server. Navigate to the link provided in the terminal output to see the page.
3+
# FNSB Energy Burden Estimator
4+
5+
<br>
6+
7+
This repository contains code and data to build a static website used for estimating the average annual household energy costs as a share of total household income in the Fairbanks North Star Borough based on energy prices and census data. This website serves as a extension of the 2024 Borough commissioned report: [Energy Burden Analysis of the Fairbanks North Star Borough](https://zenodo.org/records/12575186).
8+
9+
### Methodology
10+
Details of the methodology used to calculate energy burden can be found in the [Wiki of this repository](https://github.com/acep-uaf/energy-cost-burden-site/wiki/Methodology)
11+
12+
### Running the site locally
13+
In order to develop and run locally, install Hugo on your machine by following [this link](https://gohugo.io/installation/). Once you have Hugo installed, clone the repo, nagivate to the root directory, and run `hugo serve` to start the server. Navigate to the link provided in the terminal output (ex: `http://localhost:1313/`) to see the website.
14+
15+
### Contact
16+
If you have questions regarding this tool, please reach out via email to ACEP.info@alaska.edu.
17+
18+
### Funding
19+
Funding for this project was provided by the U.S. Department of Defense Office of Local Defense Community Cooperation Award No. GR1538-25-04.
20+
21+
### License
22+
This project is licensed under the terms of the [MIT license](LICENSE)
23+
24+
<br>
25+
<br>
26+
27+
<img src="static/images/acep-logo-dark.png" width="40%" style="margin-right: 10%"> <img src="static/images/uaf-logo.png" width="25%">

static/images/acep-logo-dark.png

215 KB
Loading

0 commit comments

Comments
 (0)