update readme

This commit is contained in:
amphineko 2020-03-22 07:44:17 +08:00
parent 0e46463788
commit fca6739c02
No known key found for this signature in database
GPG Key ID: 4582E6587852EF42

View File

@ -1,34 +1,34 @@
# ~/amphineko # ~/amphineko
This repository is a development copy of my homepage (https://futa.moe/amphineko/), which can be used as a template. This repository is the repository of my homepage (https://futa.moe/amphineko/) that can be used as a template.
Visit https://amphineko.github.io/amphineko/ for live deployment of `master` branch. Visit https://amphineko.github.io/amphineko/ for a live deployment of the `master` branch.
Text contents are mainly located at `index.html`. To replace the texts and the picture (`amphineko.png`), can be easily done by editing this file. Text contents are mainly located in `index.html`. Simply edit this file to replace the texts and the picture.
For furthermore modification, including color settings and layouts, check `index.css` and `stylesheets/*.css`. Don't forget to run `webpack` to rebuild files and reflect your modification. For further modifications, including color settings, background images, and layouts, check `index.css` and `stylesheets/*.css`. Don't forget to run an `npm run build` to rebuild files and reflect your modification.
--- ---
这里是 https://futa.moe/amphineko/ 的开发版本,也可以用来作为制作页面的模版。 这里是 https://futa.moe/amphineko/ 的代码库,也可以用来作为制作页面的模版。
访问 https://amphineko.github.io/amphineko/ 可以查看 `master` 分支的最新部署。 访问 https://amphineko.github.io/amphineko/ 可以查看 `master` 分支的最新部署。
大部分的文本内容储存在 `index.html` 中,修改这个文件即可更改页面的主图片和文本。 大部分的文本内容储存在 `index.html` 中,修改这个文件即可更改页面的主图片和文本。
若要进行更进一步的修改(如配色方案与页面布局),请编辑 `index.css``stylesheets/*.css`。完事了别忘记 `webpack` 一下来重新编译使更改生效。 若要进行更进一步的修改(如配色方案、背景图片与页面布局),请编辑 `index.css``stylesheets/*.css`。完事了别忘记 `npm run build` 一下来重新编译使更改生效。
## warning ## warning
This repository contains copyright content, including the profile picture `amphineko.png`, `badcable.png` etc. This repository contains copyright content, including the profile picture `amphineko.png`, `badcable.png`, etc.
For example, this following image shown on the bottom-right of the header: For example, this following image is shown on the bottom-right of the header:
![badcable.png](https://github.com/amphineko/amphineko/blob/39830d5c28537bd2f76067e1793f26bc121f38e1/src/assets/images/badcable.png?raw=true) ![badcable.png](https://github.com/amphineko/amphineko/blob/39830d5c28537bd2f76067e1793f26bc121f38e1/src/assets/images/badcable.png?raw=true)
These assets are specially licensed to the repository owner only. These assets are specially licensed to the repository owner only.
You should replace these assets with your own images, all of them, before deploying to your websites. You should replace these assets with your images, all of them, before deploying to your websites.
--- ---
@ -38,9 +38,21 @@ You should replace these assets with your own images, all of them, before deploy
你应该在部署到你的网站或分发之前,将这些所有的版权图片替换为你自己的图片。 你应该在部署到你的网站或分发之前,将这些所有的版权图片替换为你自己的图片。
## help wanted!
This project was created with little knowledge of Web development. Misuses of HTML tags, CSS rules, and incorrect document writing are just everywhere. Please don't hesitate to send pull requests when you find any incorrectness or improvements.
You may also see [issues](https://github.com/amphineko/amphineko/issues) to find ongoing problems.
---
我在开发时并没有拥有很多 Web 开发的知识。现在这里的 HTML 标签、CSS 规则的错误使用和不正确的文件编写到处都是。请帮助我修复这些问题,也欢迎提出新的改进。
同时你可以在 [issues](https://github.com/amphineko/amphineko/issues) 里找到现在正在处理的问题。
## build ## build
To build this repository, run these following commands. To build this project, run these following commands.
``` ```
npm install . npm install .
@ -63,8 +75,8 @@ npm run build
## known "issue" ## known "issue"
The chemical symbol in the name may flash on page load, especially on Chrome. The chemical symbol in the name may flash on page load, especially on Chrome.
This is a bug specific to Chrome (and Blink browsers). However this won't be fixed, because it's caused by Chrome and left not fixed for years. This is a bug specific to Chrome (and Blink browsers). However, this won't be fixed, because it's caused by Chrome and left not fixed for years.
Check out this issue for solution if this bothers you. (Thanks to @Nyaasu66) Check out this issue for a solution if this bothers you. (Thanks to @Nyaasu66)
https://github.com/amphineko/amphineko/issues/15 https://github.com/amphineko/amphineko/issues/15