From a9c7cbfdd4f026ca214af88001f99cc0515728cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20Marx=20Ch=C3=A1vez-Campos?= Date: Fri, 9 Oct 2020 23:20:29 +0000 Subject: [PATCH] Update Instructions on Readme file --- Readme.md | 78 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 63 insertions(+), 15 deletions(-) diff --git a/Readme.md b/Readme.md index dfb2662..dcc406a 100644 --- a/Readme.md +++ b/Readme.md @@ -2,11 +2,12 @@ This is the version `0.1` of scientific-emacs. This respositry contains the `Dockerfiles` to build the images for `Redis` and `Emacs`. # Installation -To install the container first refer to the [Docker Installation Guide](https://docs.docker.com/docker-for-windows/install/). After test the **hello worlf of Docker system**, clone this repository within your -*working directory* using: +To install the Docker System first refer to the [Docker Installation Guide](https://docs.docker.com/docker-for-windows/install/). After test `docker run hello-world`. + +Then, you are redy clone this repository within your *working directory* using: ``` -$ git clone http://gmarx.jumpingcrab.com:8088/mice-rs101/latex-basic.git +$ git clone http://gmarx.jumpingcrab.com:8088/mice-rs101/scientific-emacs ``` Then, it is possible to build the *scientifc-emacs* container by: @@ -14,21 +15,19 @@ Then, it is possible to build the *scientifc-emacs* container by: ``` $ docker build -t scientific-emacs:0.1 docker/emacs/ ``` -Write here about container -# How to install -1. Clone this repository: -`git clone xxxx` -2. Build the container using: -`docker build -t gmarxcc/scientific-emacs:0.1 docker/emacs/` -3. Run the container to test: -`docker run --rm -it gmarxcc/scientific-emacs:0.1` -4. Run an Ubuntu command like `ls` +Run the container to test it: + +``` +docker run --rm -it gmarxcc/scientific-emacs:0.1` +``` + +and run an Ubuntu command like `ls` Done, you are doing great! # Executing emacs - +## On Macos To get the ip address ''' open -a xquartz @@ -38,15 +37,64 @@ xhost + $ip To run the container -''' +``` docker run --rm -it -v`pwd`/emacs-config:/root \ -e DISPLAY=$ip:0 \ -v /tmp/.X11-unix:/tmp/.X11-unix \ gmarxcc/scientific-emacs:0.1 -''' +``` + the 'emacs-config' folder contains the '.emacs' configuration file +## On windows +### Open VcXsrv +Firts open or [install *VcXsrv Windows X Server*](https://sourceforge.net/projects/vcxsrv/). When *VcXsrv Windows X Server* is open make sure to have selected as follow the **extra settings**. Check all options as below and finish configuration. + +![XLauch settings](https://cuneyt.aliustaoglu.biz/en/content/images/2018/11/xlaunch.png) + +### Get your ip adress +Get your IP address using ipconfig command at the **PowerShell**: + + +``` +PS C:\Users\gmarx> ipconfig + +...... + +Wireless LAN adapter Wi-Fi: + + Connection-specific DNS Suffix . : rga.ip + IPv6 Address. . . . . . . . . . . : 2806:103e:5:e64e:d01:9a10:1ba8:8577 + Temporary IPv6 Address. . . . . . : 2806:103e:5:e64e:44a7:4800:cc9a:7a3c + Link-local IPv6 Address . . . . . : fe80::d01:9a10:1ba8:8577%2 + IPv4 Address. . . . . . . . . . . : 192.168.1.77 + Subnet Mask . . . . . . . . . . . : 255.255.255.0 + Default Gateway . . . . . . . . . : fe80::1%2 + 192.168.1.254 +``` + +**remember to use a physical adapter activaded, it means whit an IP address, in my case is Wi-Fi adapter IPv4 192.168.1.77. + +Now you can go to the folder of this repository and run the container using the next commands: + +``` +PS C:\Users\gmarx>cd scientific-emacs +PS C:\Users\gmarx\scientific-emacs> $ docker run --rm -it -v ${PWD}/data:/data -v ${PWD}/config/:/root -e DISPLAY=192.168.1.77:0.0 scientific-emacs:0.1 +root@d442a76cd169:/# +``` + +this means that you are already have mounted the 'scientific-emacs:0.1' image. + +Copy this code to run the container more easily: + +``` +docker run --rm -it -v ${PWD}/data:/data \ +-v ${PWD}/config/:/root \ +-e DISPLAY=your.ip:0.0 \ +scientific-emacs:0.1 +``` + # What is installed on the repository The repository has previously installed - aspell: