seeseemelk/cool-retro-term
1
0
Fork 0
Code Issues 449 Pull Requests 12 Actions Packages Projects Releases 8 Wiki Activity

Adding documentation and a cleaner dockerfile.

Browse Source
This commit is contained in:
Aric Renzo 2018-09-14 15:00:44 -04:00
parent d25346e814
commit af317fe39a
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Dockerfile
View File

@ -7,6 +7,7 @@ COPY . /app
WORKDIR /app WORKDIR /app
RUN qmake && make RUN qmake && make
#Add user to /etc/sudoers with sudo permissions
RUN adduser user --home /home/user RUN adduser user --home /home/user
WORKDIR /app WORKDIR /app
RUN chmod +x /app/cool-retro-term RUN chmod +x /app/cool-retro-term

22
README.md
View File

@ -108,7 +108,7 @@ or:
**Arch Linux** **Arch Linux**
sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects
--- ---
**openSUSE** **openSUSE**
@ -122,16 +122,22 @@ Install dependencies:
sudo zypper install libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtquickcontrols libqt5-qtgraphicaleffects sudo zypper install libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtquickcontrols libqt5-qtgraphicaleffects
--- ---
**Docker**
Docker users running X-Server can run cool-retro-term in an isolated Docker container using the following command. Please note that hardware and x-server resources need to be mounted inside the container in order for the container to have access to hardware acceleration and X-server resources:
```sh
docker run -it --privileged --rm -e DISPLAY=$DISPLAY -e XDG_RUNTIME_DIR=/run/user/1000 -e XAUTHORITY=$XAUTHORITY -v /run/user/1000:/run/user/1000 -v /tmp/.X11-unix:/tmp/.X11-unix -v /dev/dri:/dev/dri quay.io/aric49/crt:latest
```
**Anyone else** **Anyone else**
Install Qt directly from here http://qt-project.org/downloads . Once done export them in you path (replace "_/opt/Qt5.3.1/5.3/gcc_64/bin_" with your correct folder): Install Qt directly from here http://qt-project.org/downloads . Once done export them in you path (replace "_/opt/Qt5.3.1/5.3/gcc_64/bin_" with your correct folder):
export PATH=/opt/Qt5.3.1/5.3/gcc_64/bin/:$PATH export PATH=/opt/Qt5.3.1/5.3/gcc_64/bin/:$PATH
--- ---
### Compile ### Compile
Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application: Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application:
```bash ```bash
# Get it from GitHub # Get it from GitHub
@ -179,6 +185,16 @@ cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns
open cool-retro-term.app open cool-retro-term.app
``` ```
## Build Instructions Docker
Clone the primary repository with the `--recursive` flag, and perform a Docker build. Docker will automatically compile the code inside a Docker container. To run the docker container, you need to mount X-Server resources and your video card inside the Docker container so that Docker can initiate the GUI and successfully start cool-retro-term with hardware acceleration:
```sh
git clone --recursive https://github.com/Swordfish90/cool-retro-term.git
docker build -t cool-retro-term:1
docker run -it --privileged --rm -e DISPLAY=$DISPLAY -e XDG_RUNTIME_DIR=/run/user/1000 -e XAUTHORITY=$XAUTHORITY -v /run/user/1000:/run/user/1000 -v /tmp/.X11-unix:/tmp/.X11-unix -v /dev/dri:/dev/dri cool-retro-term:1
```
## Donations ## Donations
I made this project in my spare time because I love what I'm doing. If you are enjoying it and you want to buy me a beer click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted). I made this project in my spare time because I love what I'm doing. If you are enjoying it and you want to buy me a beer click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted).