danog/ecodash
1
0
Fork 0
forked from massivebox/ecodash
Code Pull requests Activity

Reorganize docs

Browse source
This commit is contained in:
MassiveBox 2024-04-19 18:30:11 +02:00
parent 924b96e0db
commit 79c7dde230
Signed by: massivebox
GPG key ID: 9B74D3A59181947D
2 changed files with 6 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
BUILD.md
View file

@ -1,28 +0,0 @@
# 👷 Building EcoDash
Here's how to build EcoDash in both binaries and as a Docker container. This is not necessary for most cases - we provide both pre-built binaries and containers for Linux ARM and x86_64 - however in devices with unsupported architectures it's necessary.
You're encouraged to first check the installation instructions to see if a pre-built container or binary is already available.
If you really have to build it yourself, we recommend you Docker over binaries.
## Binaries
### Linux
1. Download the Go Compiler from https://go.dev/dl/ or from your repository's package manager (it's usually called `go` or `golang`)
2. Download the Git SCM from https://git-scm.com/download/linux or from your package manager (it's always called `git`)
3. Download `golangci-lint` from https://golangci-lint.run/
4. Clone the repository by running `git clone https://git.massivebox.net/ecodash/ecodash.git ` inside a command prompt
5. Switch to the project directory with `cd ecodash`
6. Run `golangci-lint run` to lint all project files
7. Build with `go build src/main/main.go -o ecodash`. This will generate an executable, `ecodash`, in the same directory.
### Windows
1. Install the latest release of the Go Compiler for Windows from https://go.dev/dl/
2. Install the Git SCM from https://git-scm.com/download/win. The "Standalone installer" is recommended. All the default settings will work fine.
3. Download `golangci-lint` from https://golangci-lint.run/
4. Clone the repository by running `git clone https://git.massivebox.net/ecodash/ecodash.git ` inside a command prompt
5. Switch to the project directory with `cd ecodash`
6. Run `golangci-lint run` to lint all project files
7. Build with `go build src/main/main.go -o ecodash`. This will generate an executable, `ecodash.exe`, in the same directory.

14
README.md
View file

@ -1,21 +1,19 @@
# 🌿 EcoDash
[![status-badge](https://jenkins.massivebox.net/job/ecodash/job/master/badge/icon)](https://jenkins.massivebox.net/job/ecodash/) [![Visit our website](https://cloud.massivebox.net/s/DP3ZSaDS84wQ6jp/download?path=%2FEcoDash&files=visit-website.svg)](https://ecodash.xyz) [![Support the project](https://cloud.massivebox.net/s/DP3ZSaDS84wQ6jp/download?path=%2FEcoDash&files=support-the%20project.svg)](https://ecodash.xyz/contribute)
[![Support the project](https://cloud.massivebox.net/index.php/s/DcxB6KwkDZALbXw/download?path=%2FEcoDash&files=support-the-project.svg)](https://massivebox.net/pages/donate.html)
EcoDash is a simple way to show your users how much your server consumes.
It's intended as a medium of transparency, that gives your users an idea about the consumption of your machine. It's not meant to be 100% accurate.
You can see it in action here: https://demo.ecodash.xyz
You can see it in action here: https://ecodash.massivebox.net
## Get started
Check out the documentation in our [website](https://ecodash.xyz) to get started with EcoDash.
Check out the documentation in our [wiki](https://git.massivebox.net/massivebox/ecodash/wiki) to get started with EcoDash.
- [📖 Introduction](https://ecodash.xyz/docs)
- [🛣 Roadmap](https://ecodash.xyz/docs/roadmap)
- [⬇️ Install](https://ecodash.xyz/docs/install)
- [⚙️ Setup](https://ecodash.xyz/docs/setup)
- [🆘 Support](https://ecodash.xyz/docs/support)
- [📖 Introduction](https://git.massivebox.net/massivebox/ecodash/wiki)
- [⬇️ Installation](https://git.massivebox.net/massivebox/ecodash/wiki/install)
- [⚙️ Configuration](https://git.massivebox.net/massivebox/ecodash/wiki/config)
## License