search

norandomtechie / ece270-simulator

Source code for Web-Based Verilog Simulation Platform in ECE 27000 at Purdue University
25 stars 5 forks source link

Fixed broken links and /newline issues #13

Open kubark42 opened 3 years ago

kubark42 commented 3 years ago

I opted to fix the links by adding ../ instead of removing md/. This is because I figured for maintainability, it's much easier to do a find/replace on "../md than it is on ".

I also got rid of a few extraneous bullets and fixed some newline issues which arose because the trailing > on the Markdown HTML needs a blank newline or else it causes the subsequent character to get garbled.

kubark42 commented 3 years ago

Hmm, on second thought, this file might not be intended to be rendered from within the source code tree. I hadn't seen it in the server's walkthrough, but now I do and I wonder if this PR is misplaced.

If so, it might make sense to have a top-level file in https://github.com/norandomtechie/ece270-simulator/tree/master/md which explains how to view the contents directory. Maybe it's just enough to say something like "these *.md files will look broken if viewed from within Github, but instead go to www.foo.bar and they will render correctly.