search

AI-multimodal / aimmdb

BSD 3-Clause "New" or "Revised" License
0 stars 10 forks source link

Update README #45

Closed matthewcarbone closed 1 year ago

matthewcarbone commented 1 year ago

@CharlesC30 FYI this is what I mean about the README format.

matthewcarbone commented 1 year ago

I wonder maybe we should use pure Latex for this since it's only designed to be viewed on GitHub, and GitHub supports Math Jax rendering. I'm going to try something.

matthewcarbone commented 1 year ago

Oof.

image

I think I might just need single $'s 😁

matthewcarbone commented 1 year ago

Man this is annoying. Let's see if this renders

$\mu\mathrm{trans} = -\log(I\mathrm{trans}/I_0)$

Edit: whatever we'll go back to plaintext for this, no need to get too fancy 😁

matthewcarbone commented 1 year ago

@CharlesC30 can you make sure my modified docs look good to you? Thanks!

I'm going to merge but if you find an issue please raise it with me and I'll hot fix it.

CharlesC30 commented 1 year ago

Looks good to me! This was my first time really using rst or md, I'll have to practice with these more for the future.

matthewcarbone commented 1 year ago

Great! No problem you did a great job 👍