diff --git a/README.md b/README.md index 28e329fa4d143ed872c418795b4a947ad7f624a7..765f722b79dcd373807f902b0aa36ef691f9c281 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,23 @@ Web pages for the QIM 3D data repository. The data is placed elsewhere. Pages use [templates](https://www.w3schools.com/w3css/w3css_templates.asp) from w3schools, in particular the [portfolio](https://www.w3schools.com/w3css/tryw3css_templates_portfolio.htm) template. -## Use +## Viewing When viewing pages on your machine, your browser will probably prevent loading JavaScript code (which is used to inserts sidebar, header and footer). Instead of changing your security policy, you can run a local server, e.g. Python’s built-in http server. 1. From the command line, run `python -m http.server` (this is for Python 3.x). 1. In a browser, open [http://localhost:8000/](http://localhost:8000/) and navigate to the pages. +You might also need to force browser to load fresh content (instead of showing a cached version of the pages). In Crome (on mac), hold down Shift +while reloading. Check for your browser. + +## Modifying +You need basic html, I like to use [w3schools/html](https://www.w3schools.com/html/default.asp). And basic css, also covered by [w3schools/css](https://www.w3schools.com/css/default.asp). Get familiar with [w3.css](https://www.w3schools.com/w3css/default.asp). Make sure you check your changes in different browsers, and (when live) from different platforms. + +## Publishing +Live version is here: [http://qim.compute.dtu.dk/data-repository/](http://qim.compute.dtu.dk/data-repository/)! To change the live version, update and add files at `/www/sites/qim.compute.dtu.dk/data-repository`. + +In command line, you can use ssh or sftp to connect to server `thinlinc.compute.dtu.dk` navigate to `/www/sites/qim.compute.dtu.dk/data-repository`. + ## Content Some of the helping files are: * `w3_nature_portfolio_template.html` - This is the original template, placed here for just for reference, so you will probably not need it. @@ -20,7 +31,7 @@ Some of the helping files are: The main files are: * `index.html` - Obvious. -* `about.html` - Also prety obvious. Images are placed in about folder. +* `about.html` - Also pretty obvious. Images are placed in about folder. * `example1.html` - Rather elaborate example, you probably don't want to use this. * `example2.html` - Simpler, prefered. * `example3.html` - More images.