Tweak 0.3 docs #79
Tweak 0.3 docs #79
Conversation
Update text to match; Create UNDERSTANDING.md and COMMANDLINE.md files; Add batch_add_border.sh script for simple screen-shot processing;
media/Crusader-Client.png
Outdated
There was a problem hiding this comment.
Maybe just do a local test to avoid the odd sensoring?
There was a problem hiding this comment.
I happen to be at my Mom's house today, where the network is fast but has high latency. I think these charts are better - showing typical results, not the "best possible" when using a good router.
There was a problem hiding this comment.
Well the client screenshot doesn't have to match the result. You could also save and add the result to the data folder.
There was a problem hiding this comment.
I think the files are good now.
media/Crusader-Monitor.png
Outdated
CLI.md
Outdated
There was a problem hiding this comment.
It probably makes sense to do these changes in the code too.
|
[I'm going off-grid for about 8 or 9 hours. These are good comments: keep sending them. I will address them when I return. Thanks] |
More editorial tweaks
|
Any further changes necessary? Thanks again |
Tweak
Editorial tweaks
|
@Zoxc Thanks for updating the README. Now that I have returned home (yesterday was a travel day), I made those edits. I think this is looking pretty good. Congratulations! |
|
@Zoxc Good catch. Fixed |
|
@Zoxc - I have merged |
|
You don't need to create merge commit when there's no conflicts. I do think screenshots without any censoring would be better. |
|
@Zoxc OK. Do you see any other changes? Thanks. |
Changed `./crusader ...` to `crusader ...`
|
@Zoxc I see a merge conflict. Would you fix it? I cannot. Thanks |
|
I had new screenshots in mind instead of further editing. |
|
I'm not really sure what changes to the screen shots you would like to see. Perhaps you could commit the current state, then substitute your own screen shots... |
|
@Zoxc It has been a week since I made my last changes to the documentation. Is there a reason that you have not published them? (I have held off from publicizing Crusader until the documentation matches the software...) Thanks. |
| @@ -12,7 +12,8 @@ in the presence of upload and download traffic. | |||
| It also incorporates a continuous latency tester for | |||
| monitoring background responsiveness. | |||
|
|
|||
| Crusader uses TCP and UDP ports 35481 (only) for its tests. | |||
There was a problem hiding this comment.
I'd probably keep this and add something like:
Traffic generation uses TCP while UDP is used for latency and packet loss measurements.
I just wanted fresh new screenshots so they exactly match the actual application. |
|
I am feeling stuck:
What do you suggest? I would be completely content for you to commit this PR, then make your own editorial changes/substitute screen shots. Would that work? Thank you. |
Create a LOCAL_TESTS.md file; Passes various markdown tests
# Conflicts: # README.md
|
@Zoxc I re-organized the repo to collect all the separate instruction files into a docs directory. I also created a "Running Local Tests" document, because I think this is an important use of Crusader. What needs to happen to move this PR along? Thank you |
|
@Zoxc I continue to use Crusader, and recommend it in my blog and on various forums (example: Reddit) In particular, I would like to link to docs/LOCAL_TESTS.md for testing Wifi. But it hasn't yet been merged into the main repo. What needs to be done to make this PR (#79) suitable for merging? Thanks. |
Update screen shots to 0.3 version;
Update text to match;
Create UNDERSTANDING.md page;
Factor command line info from README into COMMANDLINE.md file;
Add batch_add_border.sh script for simple screen-shot processing;